Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add instructions for disabling the Block Directory #24357

Merged
merged 1 commit into from
Aug 5, 2020

Conversation

ryelle
Copy link
Contributor

@ryelle ryelle commented Aug 4, 2020

Description

Now that we have a way to disable the Block Directory, we should document it. See #23961 (comment) This PR adds a section into the Editor Filters section, with example code to remove the Block Directory. Looking at other docs, this seems to be the best place for it, but I'm open to moving it if there's somewhere better.

Closes #23961

How has this been tested?

View the documentation at docs/designers-developers/developers/filters/editor-filters.md

Types of changes

Documentation

@ryelle ryelle added [Type] Developer Documentation Documentation for developers [Feature] Block Directory Related to the Block Directory, a repository of block plugins labels Aug 4, 2020
@ryelle ryelle self-assigned this Aug 4, 2020
@github-actions
Copy link

github-actions bot commented Aug 4, 2020

Size Change: 0 B

Total Size: 1.16 MB

ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.67 kB 0 B
build/api-fetch/index.js 3.44 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 7.97 kB 0 B
build/block-directory/style-rtl.css 953 B 0 B
build/block-directory/style.css 952 B 0 B
build/block-editor/index.js 125 kB 0 B
build/block-editor/style-rtl.css 10.8 kB 0 B
build/block-editor/style.css 10.8 kB 0 B
build/block-library/editor-rtl.css 7.59 kB 0 B
build/block-library/editor.css 7.59 kB 0 B
build/block-library/index.js 132 kB 0 B
build/block-library/style-rtl.css 7.76 kB 0 B
build/block-library/style.css 7.77 kB 0 B
build/block-library/theme-rtl.css 728 B 0 B
build/block-library/theme.css 729 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 48.3 kB 0 B
build/components/index.js 200 kB 0 B
build/components/style-rtl.css 15.7 kB 0 B
build/components/style.css 15.7 kB 0 B
build/compose/index.js 9.68 kB 0 B
build/core-data/index.js 11.8 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.45 kB 0 B
build/date/index.js 5.38 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 3.23 kB 0 B
build/edit-navigation/index.js 10.9 kB 0 B
build/edit-navigation/style-rtl.css 1.08 kB 0 B
build/edit-navigation/style.css 1.08 kB 0 B
build/edit-post/index.js 304 kB 0 B
build/edit-post/style-rtl.css 5.61 kB 0 B
build/edit-post/style.css 5.61 kB 0 B
build/edit-site/index.js 17 kB 0 B
build/edit-site/style-rtl.css 3.06 kB 0 B
build/edit-site/style.css 3.06 kB 0 B
build/edit-widgets/index.js 9.38 kB 0 B
build/edit-widgets/style-rtl.css 2.45 kB 0 B
build/edit-widgets/style.css 2.45 kB 0 B
build/editor/editor-styles-rtl.css 537 B 0 B
build/editor/editor-styles.css 539 B 0 B
build/editor/index.js 45.3 kB 0 B
build/editor/style-rtl.css 3.8 kB 0 B
build/editor/style.css 3.79 kB 0 B
build/element/index.js 4.65 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.72 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 621 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.52 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.11 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/media-utils/index.js 5.33 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.41 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 13.9 kB 0 B
build/server-side-render/index.js 2.71 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, thanks for documenting. 👍

One comment, we probably could remove the "Experimental" title on the overall document.
It doesn't look like any of the filters would still be considered experimental. @youknowriad ?

@youknowriad
Copy link
Contributor

Yes, I don't really know why there's an "Experimental" flag there.

@mkaz mkaz merged commit 54cae4b into master Aug 5, 2020
@mkaz mkaz deleted the update/docs-disable-block-dir branch August 5, 2020 16:09
@github-actions github-actions bot added this to the Gutenberg 8.8 milestone Aug 5, 2020
mkaz added a commit that referenced this pull request Aug 5, 2020
Per #24357 the experimental in the title for editor filters is no longer
needed.
@mkaz
Copy link
Member

mkaz commented Aug 5, 2020

Merged this one and added title change in #24382

@uamv
Copy link

uamv commented Aug 5, 2020

I've been working this more. We should update the documentation to hook into admin_init rather than plugins_loaded. Doing so will allow the code to also be executed from w/in a themes functions.php file.

@mkaz
Copy link
Member

mkaz commented Aug 5, 2020

@uamv I can understand for developing your own theme, but I think it might surprise a user that using a theme could disable the block directory.

@uamv
Copy link

uamv commented Aug 5, 2020

Yeah, I was primarily considering folks who might be using a child theme. It seems that many tutorials introducing custom code snippets advise users to insert the code into functions.php. Using admin_init would also prevent this from hooking on the front-end, which, I suppose isn't a huge deal – but, seems a bit pointless.

Soean pushed a commit that referenced this pull request Aug 5, 2020
Per #24357 the experimental in the title for editor filters is no longer
needed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Block Directory Related to the Block Directory, a repository of block plugins [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Block Directory: Provide documented way to disable
4 participants